/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

#import "OFXCurrency.h"
#import "OFXAccount.h"
#import "OFXStatus.h"
#import "OFXObject.h"

@interface OFXStatement : OFXObject {
  OFXCurrency* currency;  
  OFXAccount* account;
  NSNumber* ledgerBalance;
  NSDate* ledgerBalanceValidAsOf;
  NSNumber* availableBalance;
  NSDate*   availableBalanceValidAsOf;
  NSMutableArray* transactions;
  NSMutableArray* otherBalances;
  NSDate* dateStart;  
  NSDate* dateEnd;
  NSDate* statementAsOf;
  NSString* transactionUID;
  OFXStatus* status;
  NSString* marketingInfo;
}

/**
 * @property currency
 * @brief Default currency amounts are reported in.
 */
@property(retain) OFXCurrency* currency;  

/**
 * @property account
 * @brief Account statement applies to.
 */
@property(retain) OFXAccount* account;

/**
 * @property ledgerBalance
 * @brief Ledger balance
 */
@property(retain) NSNumber* ledgerBalance;

/**
 * @property ledgerBalanceValidAsOf
 * @brief Date ledger balance valid as of.
 */
@property(retain) NSDate* ledgerBalanceValidAsOf;

/**
 * @property availableBalance
 * @brief Balance available for withdrawal.
 */
@property(retain) NSNumber* availableBalance;

/**
 * @property availableBalanceValidAsOf
 * @brief Date availableBalance valid as of.
 */
@property(retain) NSDate*   availableBalanceValidAsOf;

/**
 * @property transactions
 * @brief Array of transactions over statement period.
 */
@property(retain) NSMutableArray* transactions;

/**
 * @property otherBalances
 * @brief Array of other balances in total.
 */
@property(retain) NSMutableArray* otherBalances;

/**
 * @property 
 * @brief Starting date of statement.
 */
@property(retain) NSDate* dateStart;  

/**
 * @property dateEnd
 * @brief Ending date of statement.
 */
@property(retain) NSDate* dateEnd;

/**
 * @property statementAsOf
 * @brief Statement as of.
 */
@property(retain) NSDate* statementAsOf;

/**
 * @property transactionUID
 * @brief Client-assigned globally-unique ID for this transaction
 */
@property(retain) NSString* transactionUID;

/**
 * @property status
 * @brief Status of response
 */
@property(retain) OFXStatus* status;

/**
 * @property marketingInfo
 * @brief Marketing information
 */
@property(retain) NSString* marketingInfo;

/**
 * Initialize object.
 */
- (id)init;

@end
